home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / fish / 726-750 / 750 / addicon / addicon.doc < prev    next >
Text File  |  1995-03-18  |  18KB  |  541 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                             DOKUMENTATION
  9.  
  10.  
  11.                 AddIcon  VERSION  1.7   FREEWARE VERSION
  12.  
  13.  
  14.                         written 1992 von H.P.G.
  15.  
  16. INDEX:
  17.  
  18.  
  19.  
  20.             INDEX
  21.             General Description
  22.             History
  23.             System Requirements
  24.             Legal Stuff
  25.             FEATURES
  26.             Installation
  27.             Starting AddIcon
  28.             AddIcon START PARAMETERs
  29.             Tips
  30.             BUGS
  31.             Usage of AddIcon
  32.             List of all known IconTypes
  33.             Technical
  34.             Last
  35.             Address
  36.             List of Files
  37.  
  38.  
  39.  
  40.  
  41. General Description:
  42.  
  43.         AddIcon [AI] is a cli tool that enables you to  copy  icons  to
  44.         files and dirs in a very easy manner.
  45.  
  46.         AI has a lot of cli options.
  47.  
  48.         AI supports PatternMatching (that means use of #? ~#? [a-u]) in
  49.         filenames like original AmigaDOS standart.
  50.  
  51.         AddIcon needs OS 2.xx. Version 36 may have problems, because of
  52.         some functions which have not been implemented in this version.
  53.         Because  of  using  a lot of the new OS 2.0 features, AI is not
  54.         able to run under OS 1.2 and 1.3.
  55.         It is recommented to use Kickstart versions greater than Version
  56.         36.
  57.  
  58.         The icons, AI adds to the specified files,  must be  located in
  59.         the logical device or assign 'Icons:'.
  60.         You can simply copy the Icons on this disk to your WBench disk.
  61.         Then you have to insert the following line in to your
  62.         Startup-Sequence:
  63.  
  64.         Assign Icons: <name of the dir your icons are located>
  65.  
  66.         AddIcon automatically knows many different types of files.
  67.         AI recognizes the type of an file first by analysing its suffix
  68.         '.xx' .
  69.  
  70.         E.g. a file with extension '.c' will always be analysed as a C
  71.         source.
  72.         Files with suffixes '.ilbm' will be recognized as PICTURES.
  73.  
  74.         If AI finds a file without suffix it  looks  in  the  file  for
  75.         Iff-Chunks.
  76.  
  77.         If AI finds no chunk it reads the file. If  the  file  contains
  78.         more than 90% ASCII chars it would be handeled as an ASCII file.
  79.  
  80.         Warning: On large files it can take a lot of time to  read  the
  81.                  file.
  82.  
  83.         If AI can find the type of file in this way it copies the  icon
  84.         according to the found type to it.
  85.  
  86.         Surely you can change the icons or use yourown icons  with  AI.
  87.         So you can change e.g. the DefaultTool of  a  project  icon  to
  88.         yourown need.
  89.  
  90.         If you use e.g TurboText as text editor,  you  can  change  the
  91.         DefaultTool of the ASCII icon simply to  'c:TTX'.  If  you  now
  92.         doubleclick on this icon,  TTX  will  be  automatically  called
  93.         with the filename of the icon.
  94.  
  95.         This does the same  with  all  other  project  icons.  But  the
  96.         programms you want to  start,  must  have  be  the  ability  of
  97.         extended selections via WBench.
  98.  
  99.  
  100. History:
  101.  
  102. Version 0.1 - 0.9:
  103.  
  104.         Beta versions whithout real  functions.  Only  written  for  an
  105.         exercise, to learn something about Amigas.
  106.  
  107. Version 1.0 - 1.3
  108.  
  109.         Full functionable under Kickstart 1.3. With Intuition-interface
  110.         but without type checking of icons, needs ARP.Library  V  39.1.
  111.  
  112. Version 1.4
  113.  
  114.         Enhancements of the user-interface. Exchange  Arp.Library  with
  115.         using the new Req.Library.
  116.  
  117. Version 1.5
  118.  
  119.         Enhancements of handling. New functions implemented.
  120.  
  121. Version 1.6
  122.  
  123.         First OS 2.xx only  version.  Beta  version.  Still  using  old
  124.         functions for  command-line-parsing.  Only  a  few  Parameters.
  125.  
  126. Version 1.61 - 1.68
  127.  
  128.         Enhancements and a lot of new functions.  Consequently  use  of
  129.         the new OS 2.xx functions.  Output  of  the  program  enhanced.
  130.         Faster type-checking while analyzation. New  QUICK-,  ASK-  and
  131.         UPDATE-options.
  132.         Supports now Pattern-Matching.
  133.  
  134. Version 1.7
  135.  
  136.         No more intution-interface is used.
  137.         New ^C-Break-Handling. Now you can stop  the  program  at  each
  138.         moment, withoutlosing memory or locks etc.
  139.         New implementation of an EasyRequester, that ask if an ^C break
  140.         is received, if you want to break or goon.
  141.         Faster type-checking while analyzation. New, analyzing  of  IFF
  142.         chunks. Now,AI is looking for the amount of  ascii-chars  in  a
  143.         file. AI now looks for its icons in the logical device 'ICONS:'.
  144.         So more flexibility by using different sets of icons.
  145.         AI now is able to add icons to the contents of a whole directory
  146.         ( including Pattern-Matching).
  147.         First general Release.
  148.  
  149.  
  150. System Requirements:
  151.  
  152.         For AI you need Kickstart 2.xx Version 37.xx.
  153.  
  154.         You must have the logical device named 'Icons:'.
  155.         There should be all icons located , that are also in the
  156.         Icons drawer on this Disk.
  157.  
  158.         Do not use AI for very large Files. It also takes a lot of time.
  159.         AI allocates a buffer to hold the whole file in, so if it finds
  160.         a large file you can not only wait a while but you  can  get  a
  161.         memory  shortage.  To  prevent  that  use  the  QUICK   options
  162.         (see below).
  163.  
  164.  
  165. Legal Stuff:
  166.  
  167.  
  168.         This  program  and  all files come with it, also the docfiles,
  169.         are released as FREEWARE.
  170.  
  171.         this means:
  172.  
  173.             everybody may use AddIcon,
  174.  
  175.             everybody may copy AddIcon, if:
  176.  
  177.                 1. You copy all included files, see list at the end of the
  178.                    doc file.
  179.                 2. No changes are made,  this  means  the  program and all
  180.                    included files must stay in the original form.
  181.                    Exception: you  may  archieve  it; but in this case you
  182.                               must also archieve the whole package.
  183.                 3. If  you  recompile  it, you have to include a notice to
  184.                    the original author. If you also want to (re)distribute
  185.                    in any new form you have to send me a copy.
  186.                 4. You may not sell AddIcon.
  187.                    Execption: you`re  allowed  to  take  a  small copy fee
  188.                               which should not extend 5US$.
  189.                 5. If you want to include AddIcon
  190.                    or one of the  included files as a part of a commercial
  191.                    package,  you  must  have  written  permission  of  the
  192.                    author (address see below).
  193.  
  194.  
  195.         I take no warranty or garanty for the function of this program.
  196.         The whole risk of using AddIcon stays only by the user.
  197.  
  198.  
  199.  
  200.  
  201. FEATURES:
  202.  
  203.         - Full AmigaDOS standart PatternMatching support
  204.  
  205.         - take advantage of many new OS 2.xx features and is therefor
  206.           very small
  207.  
  208.         - AddIcon knows a lot of different file types
  209.  
  210.         - It has an update option that lets you copy icons only to
  211.           files and dirs which currently doesn`t own icons
  212.  
  213.         - Ask option enables the user to break AddIcon before copying
  214.           anything
  215.  
  216.         - Quick option spents a lot of time by larger files
  217.  
  218.         - Automatic recognizing of IFF-Chunks in files
  219.  
  220.         - Analysing of files for binary and ascii chars
  221.  
  222.         - You can use yourown icons and different sets
  223.  
  224.         - Full information is given if any error occures
  225.  
  226.         - Full information about current status
  227.  
  228.  
  229. Installation:
  230.  
  231.  
  232.         Simply copy AddIcon into your C: or any other directory in your
  233.         current AmigaDOS searchpath.
  234.  
  235.         You should copy the Icons dir on this disk anywhere to your
  236.         WorkBench disk.
  237.  
  238.         You should insert the following line in you Startup-Sequence
  239.  
  240.         .
  241.         .
  242.         .
  243.  
  244.         Assign Icons: <Path of your icon dir>
  245.  
  246.         .
  247.         .
  248.         .
  249.  
  250.  
  251. Starting AddIcon:
  252.  
  253.  
  254.         You must start AddIcon from the Cli. Alternatively you can  use
  255.         the WBench menuitem 'Execute Command'  and  then  type  in  the
  256.         StringGadget AddIcon <parameter>.
  257.  
  258.  
  259.  
  260. AddIcon START PARAMETERs:
  261.  
  262.  
  263.         AI has the following
  264.  
  265.         Syntax: AddIcon <INFO/S|TO>[UPDATE/S][ASK/S][QUICK/S][QUIET/S]
  266.                         [NOCOL/S]
  267.  
  268.         INFO         ------------     if you specify INFO,  AddIcon  gives
  269.                                       out a list of  all   current   known
  270.                                       types of files and chunks and  their
  271.                                       icon types. The  icons   should   be
  272.                                       named dependent to  the  icon  types
  273.                                       in this list.
  274.  
  275.         TO           String           For TO you have  to  specify  a  dir
  276.                                       or a filename. You have  to  specify
  277.                                       the names without  any  '.info'.  If
  278.                                       TO is  a  dir  there  are  different
  279.                                       ways:
  280.  
  281.                        1. you want to copy an icon with the type DRAWER to
  282.                           a Dir:
  283.  
  284.                           TO must be simply the name of the dir you wants
  285.                           to copy the icon to.
  286.  
  287.                           Ex.:  AddIcon sys:c
  288.  
  289.                           In this case AI would copy an icon with the type
  290.                           DRAWER to SYS: with the name c.info
  291.  
  292.                        2. you wants to copy Icons to all files of the given
  293.                           dir:
  294.  
  295.                           TO must end with a ':' or '/'.
  296.  
  297.                           Ex.:  AddIcon sys:text/
  298.  
  299.                           In this case AddIcon would  copy  icons  to  all
  300.                           subdirectories  of  the  given  dir   'sys:text'
  301.  
  302.  
  303.         UPDATE         ------------     If  you  specify  UPDATE,  AddIcon
  304.                                       only  copies  icons  to  files   and
  305.                                       dirs  that  currently  doesn`t   own
  306.                                       any icon.
  307.  
  308.         ASK           ------------    If you specify  ASK,  AddIcon  askes
  309.                                       you each time  before  it  tries  to
  310.                                       copy an icon  to  cancel  or  go  to
  311.                                       the next.
  312.  
  313.                           AI displays then this little Text:
  314.  
  315.                           Do you want to create <ICON-Name> with the  type
  316.                           <IconType> (y)es|(n)o|(c)ancel
  317.  
  318.                           - if you tyoe in y, the  Icon  would  be  copied
  319.                           - if you  type  in  c,  the  program  terminates
  320.                           - if type in n or anything else,  AddIcon  looks
  321.                             for the next matching name.
  322.  
  323.                           If you want to copy icons to dirs which contents
  324.                           are unknwon, you should use the  ASK  and  QUICK
  325.                           option.
  326.                           AddIcon knows a lot of file types but  not  all.
  327.                           If you want to get sure that you not copy a wrong
  328.                           icon type to a file or to overwrite an  existing
  329.                           icon you should  also  use  the  UPDATE  option.
  330.  
  331.         QUICK         ------------    if  you  specify  Quick,  you  saves
  332.                                       time  if   AddIcon   find   a   file
  333.                                       without   suffix   and   wants    to
  334.                                       analyze it.
  335.                                       In this case AI thinks files without
  336.                                       suffix that are larger than 5 kbytes
  337.                                       are from the type TOOL.
  338.  
  339.         QUIET         ------------    AI informs you immediatly about  its
  340.                                       status.  If  you  specify  QUIET  no
  341.                                       informations except  error  messages
  342.                                       will be sent out.
  343.  
  344.         NOCOL         ------------    Usually AI writes  its  messages  in
  345.                                       two colors. If you want  to  prevent
  346.                                       AI to do this, you can specify NOCOL.
  347.                                       All output informations are send  in
  348.                                       black.
  349.  
  350.                                       Also if you use the INFO option.
  351.  
  352.  
  353.         All options and PARAMETERs may occur in any order.
  354.  
  355.         If an error occures AI gives you a message.
  356.  
  357.  
  358. *** If you start AI without any PARAMETERs  a  little  helptext  will   be
  359. *** given. This helptext comes also if you give  AI  a  wrong  Commandline
  360.  
  361.  
  362. Tips:
  363.  
  364.      You can easy use different sets of icons.
  365.      You only have to change your Icons: assign.
  366.      The best way to do this is to write a batch-script of the follwing
  367.      kind Ex.:
  368.  
  369.      .OPT RELEASE
  370.  
  371.      if <RELEASE> EQ FISH
  372.         assign ICONS: sys:FishDisks
  373.      endif
  374.      if (RELEASE> EQ NORMAL
  375.         assign ICONS: sys:NormalIcons
  376.      endif
  377.      ...
  378.  
  379.  
  380.      If this script is in your current AmigaDOS searchpath (e.g. S:)
  381.      and you have set the S-Bit via 'Protect <Name> +s' you can use
  382.      the icons in the sys:fishdisk dir with AI by typing
  383.  
  384.        1> <Name> FISH   ; Name = name of this batch script
  385.  
  386. BUGS:
  387.  
  388.     (Is not a real Bug)
  389.  
  390.     AddIcon uses the official PatternMatching routines of the
  391.     dos.library. So AddIcon is not able to use patterns like
  392.  
  393.          sys:utilities/a~(#?info)
  394.  
  395.     That means you should not use excluding patterns like  ~(...),
  396.     because AI adds intern a ~(#?.info) to your specified path.
  397.  
  398.     You should notice that the Dos PatternMatch routins adds no '/' to
  399.     dir  patterns. That means if you specify patterns, you cannot copy
  400.     icons to a whole directory only to several dirs and files.
  401.  
  402.     Ex.:     With  1> AddIcon sys:uti#?
  403.  
  404.     AddIcon would copy an icon with the Type DRAWER to
  405.  
  406.         sys:utilities.info
  407.  
  408.     But if you want to copy icons to each file of the dir
  409.  
  410.         'sys:utilities'
  411.  
  412.     than you can type:
  413.  
  414.              1> AddIcon sys:util#?/#?
  415.  
  416.     To each file in the dir sys:utilities an icon would be copyed.
  417.  
  418.  
  419. Usage of AddIcon:
  420.  
  421. Here are some other examples:
  422.  
  423.             1> AddIcon Ram:#? UPDATE ASK
  424.  
  425.             AI looks for the contents of your RamDisk, (assuming) which
  426.             doesn`t own any icons.
  427.             Then AI askes you for each entry if you want to copy the
  428.             according icon. If all dirs and files in RamDisk owns an
  429.             icon nothing happens.
  430.  
  431.             1> AddIcon c:a#? QUICK
  432.  
  433.             AI uses the fast algorythm. To all files in the dir C:
  434.             thats name starts with an 'A' a tool icon will be copyed.
  435.  
  436. List of all known IconTypes:
  437.  
  438.     Icon TYPE         Suffix of Types               Description
  439. _________________________________________________________________________
  440.      ASCII            .asc                          Text
  441.      PICTURE          .iff .ilbm .pic .br           Picture
  442.      MUSIC            .mod .med                     Music
  443.      BATCHFILE        .bat                          AmigaDOS script
  444.      CSHSCRIPT        .sh                           Csh-Script
  445.      PAGESTREAM       .tem                          PageStream document
  446.      PREFS            .prefs .config .cfg .def      Preferences file
  447.      ASM              .asm .s                       ASM source
  448.      SOURCE           .c                            C source
  449.      HEADER           .h                            C header
  450.      OBJECT           .o                            Object file
  451.      LIBRARY          .library                      Library
  452.      CLIB             .lib .oss .osl .ols .oll      C library
  453.      DOC              .readme .doc .dok .man        Document
  454.      REXX             .rexx .dme                    Rexx script
  455.      ANIM             .anim                         Animation
  456.      ASMINC           .i                            ASM include
  457.  
  458. In files without suffix AI searches for the following Iff-Chunks
  459.  
  460.     Icon Type            Iff Chunk
  461.  
  462.      ILBM                 PICTURE
  463.      SMUS                 MUSIC
  464.      FTXT                 TEXT
  465.      8SVX                 MUSIC
  466.      ANIM                 ANIM
  467.  
  468. In files without suffix and without Iff-Chunk AI searches also for
  469. their amount of binaries and ascii-chars.
  470. If a file contains more than 90% ascii chars AddIcon handles the file
  471. like a textfile (TYPE ASCII).
  472.  
  473. ( only if you do not use the QUICK-Option )
  474.  
  475.  
  476. Technical:
  477.  
  478.  
  479.         AI is written in C with the Manx Aztec C V 5.2a - Compiler
  480.  
  481.         AI uses the new DOS ReadArgs functions for CommandLine-
  482.         Parsing and the MatchFirst, MatchNext and MatchEnd functions
  483.         for PatternMatching.
  484.  
  485. Last:
  486.  
  487.         I hope AddIcon will be used by many peoples. If you find any
  488.         bugs please send me a message.
  489.         Also serious critic and/or new ideas are wellcomed.
  490.  
  491. Address:
  492.  
  493. Send all messages to:
  494.  
  495.                 Hans - Peter Guenther
  496.  
  497.                 Gruener Weg 5
  498.  
  499.                 3501 Fuldatal 2
  500.  
  501.                 ( B.R.D )
  502.  
  503. List of Files:
  504.  
  505. (If any of the following Files is not in this Release you`ve got an
  506.  incomplete one. Please let me know.)
  507.  
  508.  
  509.  
  510. List csrc:AddIcon LFormat "%s"
  511.  
  512. AddIcon.dok         : German documentation
  513. AddIcon.dok.info
  514. AddIcon.doc         : English documentation
  515. AddIcon.doc.info
  516. AddIcon             : The binary
  517. AddIcon.info
  518. ReadMeFirst.doc     : English short overview
  519. ReadMeFirst.doc.info
  520. ReadMeFirst.dok     : German short overview
  521. ReadMeFirst.dok.info
  522. LegalStuff.doc      : English LegalStuff
  523. LegalStuff.doc.info
  524. Rechtliches.dok     : German LegalStuff
  525. LegalStuff.doc.info
  526. Icons   (dir)       : This dir contains several icons from several
  527.                       authors and is not copyrighted.
  528.  
  529. ---
  530. END
  531.  
  532.  
  533.  
  534.  
  535. Have fun  ...
  536.  
  537.                 H.P.G
  538.  
  539.  
  540.  
  541.